Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(cli): update latest cli documentation #3306

Merged
merged 1 commit into from
Oct 20, 2024
Merged

docs(cli): update latest cli documentation #3306

merged 1 commit into from
Oct 20, 2024

Conversation

asyncapi-bot
Copy link
Contributor

@asyncapi-bot asyncapi-bot commented Oct 20, 2024 •
edited by coderabbitai bot
Loading

Updated cli documentation is available and this PR introduces update to cli folder on the website

Summary by CodeRabbit

  • Documentation
    • Updated formatting and structure of the CLI usage documentation for improved readability.
    • Added a new description for the asyncapi start command, clarifying its function in starting AsyncAPI services.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Oct 20, 2024 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve modifications to the usage.md file located in the markdown/docs/tools/cli directory. These modifications include formatting adjustments such as changing title quotes, reformatting the comments section, and enhancing the usage section with additional spacing and bullet style changes. A new description for the asyncapi start command has been added, providing clarity on its function.

Changes

File Path Change Summary
markdown/docs/tools/cli/usage.md Title quotes changed from single to double quotes; comments reformatted; usage section expanded with new line additions; command list reformatted from asterisks to plus signs; new description added for asyncapi start command.

Suggested reviewers

  • derberg
  • magicmatatjahu
  • devilkiller-ag
  • akshatnema
  • sambhavgupta0705
  • anshgoyalevil
  • Mayaleeeee
  • asyncapi-bot-eve

Poem

In the docs where rabbits play,
Formatting changes brighten the day.
With plus signs hopping, clear and bright,
AsyncAPI's commands now take flight!
A new line here, a quote there,
Clarity blooms in the fresh air! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@netlify Netlify
Copy link

netlify bot commented Oct 20, 2024 •
edited
Loading

✅ Deploy Preview for asyncapi-website ready!

Name Link
🔨 Latest commit 8d026dc
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/671520f8929edb0008d3f208
😎 Deploy Preview https://deploy-preview-3306--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@codecov Codecov
Copy link

codecov bot commented Oct 20, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 53.17%. Comparing base (9a1c3a6) to head (8d026dc).
Report is 1 commits behind head on master.

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #3306   +/-   ##
=======================================
  Coverage   53.17%   53.17%           
=======================================
  Files          21       21           
  Lines         598      598           
=======================================
  Hits          318      318           
  Misses        280      280

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@asyncapi-bot
Copy link
Contributor Author

⚡️ Lighthouse report for the changes in this PR:

Category Score
🔴 Performance 47
🟢 Accessibility 98
🟢 Best practices 92
🟢 SEO 100
🔴 PWA 33

Lighthouse ran on https://deploy-preview-3306--asyncapi-website.netlify.app/

@asyncapi-bot asyncapi-bot merged commit 3a8f69a into master Oct 20, 2024
29 of 30 checks passed
@asyncapi-bot asyncapi-bot deleted the update-cli-docs-2e5c6cd224eef9f8924c7d7ec961b37fd0123f21 branch October 20, 2024 15:29
@coderabbitai coderabbitai bot mentioned this pull request Oct 27, 2024
Merged
This was referenced Nov 6, 2024
Merged
Merged
This was referenced Nov 18, 2024
Closed
Merged
@coderabbitai coderabbitai bot mentioned this pull request Nov 29, 2024
Merged
This was referenced Dec 7, 2024
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@asyncapi-bot-eve asyncapi-bot-eve asyncapi-bot-eve approved these changes

@quetzalliwrites quetzalliwrites Awaiting requested review from quetzalliwrites quetzalliwrites is a code owner

@devilkiller-ag devilkiller-ag Awaiting requested review from devilkiller-ag

@sambhavgupta0705 sambhavgupta0705 Awaiting requested review from sambhavgupta0705

@BhaswatiRoy BhaswatiRoy Awaiting requested review from BhaswatiRoy

@J0SAL J0SAL Awaiting requested review from J0SAL

@TRohit20 TRohit20 Awaiting requested review from TRohit20

@VaishnaviNandakumar VaishnaviNandakumar Awaiting requested review from VaishnaviNandakumar

Assignees
No one assigned
Labels
autoapproved autoupdate
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@asyncapi-bot @asyncapi-bot-eve